home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / PHPDoc / accessor / PhpdocWarningAccessor.php < prev   
Encoding:
PHP Script  |  2001-02-18  |  2.2 KB  |  93 lines
  1. <?php
  2. /**
  3. * Extracts the warnings from PHPDoc warnings_* files.
  4. * 
  5. * @version  $Id: PhpdocWarningAccessor.php,v 1.2 2001/02/18 15:03:05 uw Exp $
  6. */
  7. class PhpdocWarningAccessor extends PhpdocAccessor {
  8.  
  9.     /**
  10.     * If set to true all get_xy() functions will free their resources.
  11.     *
  12.     * @var      boolean
  13.     * @access   public
  14.     */
  15.     var $freeOnGet = true;    
  16.     
  17.     /**
  18.     * Array of warnings.
  19.     *
  20.     * @var      array
  21.     */
  22.     var $warnings = array();
  23.     
  24.     /**
  25.     * Flag used to detect if get_xy() was called.
  26.     *
  27.     * @var      boolean
  28.     */
  29.     var $flag_build = false;
  30.     
  31.     /**
  32.     * Returns a hash of warnings in of the given XML file.
  33.     *
  34.     * @param    string  XML file
  35.     * @return   array
  36.     * @access   public
  37.     * @see      $freeOnGet
  38.     */
  39.     function getWarnings($xmlfile) {
  40.         
  41.         $this->buildWarnings($xmlfile);
  42.         
  43.         if ($this->freeOnGet) {
  44.             
  45.             $data = $this->warnings; 
  46.             $this->warnings = array();
  47.             return $data;
  48.             
  49.         } else {
  50.             
  51.             return $this->warnings;
  52.             
  53.         }
  54.         
  55.     } // end func getWarnings
  56.     
  57.     /**
  58.     * Build the internal list of warnings.
  59.     *
  60.     * @param    string  XML file to load
  61.     */
  62.     function buildWarnings($xmlfile) {
  63.         
  64.         if ($this->flag_build)
  65.             return;
  66.             
  67.         $this->flag_build = true;
  68.         $this->warnings        = array();
  69.         $this->loadXMLFile($xmlfile);
  70.  
  71.         if(!isset($this->xml["warnings"][0]))
  72.             $this->xml["warnings"] = array( $this->xml["warnings"] );
  73.         
  74.         reset($this->xml["warnings"]);
  75.         while (list($k, $warnings) = each($this->xml["warnings"])) {
  76.         
  77.             $file = $warnings["file"];
  78.             if (!isset($warnings["warning"][0])) 
  79.                 $warnings["warning"] = array($warnings["warning"]);
  80.             $this->warnings[$file] = $warnings["warning"];
  81.                     
  82.         }
  83.  
  84.         $this->xml = "";
  85.         
  86.     } // end func buildWarnings
  87.     
  88.     function init() {
  89.         $this->flag_build = false;
  90.     } // end func init
  91.     
  92. } // end class PhpdocWarningAccess
  93. ?>